Expose Sense report interval to HA #331

dirixmjm · 2025-09-11T18:10:28Z

Summary by CodeRabbit

New Features
- Added a configurable "Measurement report interval" number setting for compatible Plugwise USB devices (minutes, 1–60). Labels available in English and Dutch.
Chores
- Re-enabled a previously ignored lint rule in tooling.
- Bumped integration and dependency versions (plugwise-usb to v0.46.0, integration v0.57.0) and updated changelog.

coderabbitai · 2025-09-11T18:10:36Z

Walkthrough

Adds a new numeric entity description for a measurement report interval (report_interval) to NUMBER_TYPES, updates UI strings and translations, bumps package/manifest versions, and removes a Ruff ignore for UP038 in pyproject.toml.

Changes

Cohort / File(s)	Summary of Changes
Number entity: report interval `custom_components/plugwise_usb/number.py`	Added `report_interval` `PlugwiseNumberEntityDescription` (key="report_interval", translation_key="sense_report_interval", async_number_fn="set_report_interval", node_feature=NodeFeature.SENSE_HYSTERESIS, device_class=NumberDeviceClass.DURATION, unit=UnitOfTime.MINUTES, entity_category=EntityCategory.CONFIG, native_min=1, native_max=60, native_step=1, mode="box").
Localization and labels `custom_components/plugwise_usb/strings.json`, `custom_components/plugwise_usb/translations/en.json`, `custom_components/plugwise_usb/translations/nl.json`	Added `sense_report_interval` label: strings.json -> "Measurement report interval"; translations/en.json -> "Measurement reporting interval"; translations/nl.json -> "Meetrapportage-interval".
Manifest and versioning `custom_components/plugwise_usb/manifest.json`, `pyproject.toml`, `CHANGELOG.md`	Bumped integration version (0.56.0 → 0.57.0) and `plugwise-usb` requirement (0.45.0 → 0.46.0); pyproject project version bumped (0.55.13 → 0.57.0); added CHANGELOG entry for v0.57.0.
Tooling/config `pyproject.toml`	Removed Ruff ignore for UP038 (re-enabling that lint rule); no runtime code changes.

Sequence Diagram(s)

sequenceDiagram
  participant U as User (HA UI)
  participant HA as Home Assistant Number Entity
  participant PW as Plugwise USB Integration
  participant N as USB Node

  U->>HA: Set report_interval (minutes)
  HA->>PW: call async_number_fn: set_report_interval(value)
  PW->>N: send new reporting interval
  N-->>PW: acknowledge / apply
  PW-->>HA: update entity state
  HA-->>U: show updated value

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Activate new Sense hysteresis based switch action #326 — Also modifies NUMBER_TYPES for SENSE_HYSTERESIS-related number entities; closely related to this addition.
Improve platform logging, available logging, try fix button availability #319 — Related changes to per-entity creation/logging for number entities referenced by this PR.
Bump plugwise-use to v0.44.8 #290 — Bumps manifest dependency/version similar to this PR.

Suggested reviewers

bouwew

Poem

A rabbit taps the interval drum,
Tick, hop, tick—reports will come.
Minutes boxed from one to sixty,
Sensors hum in steady ditty.
I twitch my nose — the setting's set. 🥕⏱️

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d29c4bf and 478184a.

📒 Files selected for processing (7)

CHANGELOG.md (1 hunks)
custom_components/plugwise_usb/manifest.json (1 hunks)
custom_components/plugwise_usb/number.py (1 hunks)
custom_components/plugwise_usb/strings.json (1 hunks)
custom_components/plugwise_usb/translations/en.json (1 hunks)
custom_components/plugwise_usb/translations/nl.json (1 hunks)
pyproject.toml (1 hunks)

✅ Files skipped from review due to trivial changes (1)

CHANGELOG.md

🚧 Files skipped from review as they are similar to previous changes (5)

custom_components/plugwise_usb/number.py
pyproject.toml
custom_components/plugwise_usb/translations/nl.json
custom_components/plugwise_usb/translations/en.json
custom_components/plugwise_usb/strings.json

🔇 Additional comments (2)

custom_components/plugwise_usb/manifest.json (2)

13-13: Approve version bump to 0.57.0 — metadata and changelog are in sync.
Manifest, pyproject.toml, and CHANGELOG.md all show 0.57.0 (CHANGELOG entry dated 2025-09-12 referencing PR #331).

12-12: Sanity-check plugwise-usb 0.46.0 API and gating
Pin to 0.46.0 looks correct—sense_report_interval entity and translations are present, and the number entity is tied to NodeFeature.SENSE_HYSTERESIS. Manually confirm that plugwise-usb 0.46.0 defines set_report_interval and NodeFeature.SENSE_HYSTERESIS, and that your async_setup_entry filters descriptions by node.features to guard unsupported devices.

Pre-merge checks (3 passed)

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title "Expose Sense report interval to HA" is concise and directly reflects the primary change: exposing the Sense report_interval configuration to Home Assistant via a new Number entity and related translations/manifest updates, so a reviewer scanning history will understand the main intent. It is specific, focused, and free of irrelevant noise.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch mdi_sense

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

dirixmjm · 2025-09-11T18:17:09Z

@coderabbitai review

coderabbitai · 2025-09-11T18:17:16Z

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai

Actionable comments posted: 2

🧹 Nitpick comments (2)

custom_components/plugwise_usb/translations/en.json (1)
176-178: Improve wording for natural English

"Measurement report interval" reads awkwardly; "Measurement reporting interval" is idiomatic and aligns with similar labels.
-      "sense_report_interval": {
-        "name": "Measurement report interval"
+      "sense_report_interval": {
+        "name": "Measurement reporting interval"
custom_components/plugwise_usb/strings.json (1)
176-178: Keep base string consistent with en translation

Mirror the improved phrasing so translations stay in sync.
-      "sense_report_interval": {
-        "name": "Measurement report interval"
+      "sense_report_interval": {
+        "name": "Measurement reporting interval"

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1a09f24 and d29c4bf.

📒 Files selected for processing (5)

custom_components/plugwise_usb/number.py (1 hunks)
custom_components/plugwise_usb/strings.json (1 hunks)
custom_components/plugwise_usb/translations/en.json (1 hunks)
custom_components/plugwise_usb/translations/nl.json (1 hunks)
pyproject.toml (0 hunks)

💤 Files with no reviewable changes (1)

pyproject.toml

custom_components/plugwise_usb/number.py

custom_components/plugwise_usb/translations/nl.json

sonarqubecloud · 2025-09-12T08:44:54Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

bouwew

Nice work @dirixmjm !

dirixmjm added 2 commits September 11, 2025 20:02

Add number to set the Sense report internal

ccedce7

remove removed ignore as recommended

d29c4bf

coderabbitai bot reviewed Sep 11, 2025

View reviewed changes

custom_components/plugwise_usb/number.py Show resolved Hide resolved

custom_components/plugwise_usb/translations/nl.json Show resolved Hide resolved

dirixmjm added 4 commits September 11, 2025 20:28

CR: Improve wording for natural English

1aeff3c

CR: Add native_step=1; implement/verify report_interval wiring

d064a4b

CR: Fix Dutch typo and compound noun

71fb4cf

bump version to 0.57.0

478184a

dirixmjm marked this pull request as ready for review September 12, 2025 08:47

dirixmjm requested a review from a team as a code owner September 12, 2025 08:47

dirixmjm requested review from bouwew and removed request for a team September 12, 2025 08:59

bouwew approved these changes Sep 12, 2025

View reviewed changes

dirixmjm merged commit 3206367 into main Sep 12, 2025
12 checks passed

bouwew deleted the mdi_sense branch September 16, 2025 11:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Expose Sense report interval to HA #331

Expose Sense report interval to HA #331

Uh oh!

dirixmjm commented Sep 11, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Sep 11, 2025 •

edited

Loading

Uh oh!

dirixmjm commented Sep 11, 2025

Uh oh!

coderabbitai bot commented Sep 11, 2025

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud bot commented Sep 12, 2025

Uh oh!

bouwew left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Expose Sense report interval to HA #331

Expose Sense report interval to HA #331

Uh oh!

Conversation

dirixmjm commented Sep 11, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Sep 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

Pre-merge checks (3 passed)

Uh oh!

dirixmjm commented Sep 11, 2025

Uh oh!

coderabbitai bot commented Sep 11, 2025

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud bot commented Sep 12, 2025

Quality Gate passed

Uh oh!

bouwew left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

dirixmjm commented Sep 11, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Sep 11, 2025 •

edited

Loading